Bundle org.nuxeo.apidoc.repo

Documentation

Parent Documentation: ReadMe.md
About Explorer

These modules provide an API to browse the Nuxeo distribution tree:
```
- BundleGroup (maven group or artificial grouping)
  - Bundle
    - Component
      - Service
      - Extension Points
      - Contributions
- Operations
- Packages
```
The Nuxeo Distribution can be:
- live: in memory (meaning runtime introspection)
- persisted: saved in Nuxeo Repository as a tree of Documents
The following documentation items are also extracted:
- documentation that is built-in Nuxeo Runtime descriptors
- readme files that may be embedded inside the jar
What it can be used for
- browse you distribution
- check that a given contribution is deployed
- play with Nuxeo Runtime
Configuration

The template explorer-sitemode enables the nuxeo.conf property org.nuxeo.apidoc.site.mode and defines an anonymous user. The property org.nuxeo.apidoc.site.mode comes with a more user friendly design and hides the current "live" distribution from display and API.

The template explorer-virtualadmin disables the usual Administrator user creation at database initialization and adds a virtual admin user with name apidocAdmin, whose password can be changed using nuxeo.conf property org.nuxeo.apidoc.apidocAdmin.password.

The template explorer-disable-validation disables validation on documents: it is used as an optimization to speed up distributions imports, but should not be used on a Nuxeo instance not dedicated to the explorer package usage.

Modules

This plugin is composed of 3 bundles:
- nuxeo-apidoc-core: for the low level API on the live runtime
- nuxeo-apidoc-repo: for the persistence of exported content on the Nuxeo repository
- nuxeo-apidoc-webengine: for JAX-RS API and Webview

Resolution Order

[43, 74]

The resolution order represents the order in which components have been resolved by the Nuxeo Runtime framework. This range represents the minimal and maximal orders for this bundle's components.
You can influence this order by adding "require" tags in the component declaration, to make sure it is resolved after another component. It will also impact the order in which contributions are registered on their target extension point (see "Registration Order" on contributions).

Components

Packages

platform-explorer

Maven Artifact

File	nuxeo-apidoc-repo-21.1.1.jar
Group Id	org.nuxeo.ecm.platform
Artifact Id	nuxeo-apidoc-repo
Version	21.1.1

Manifest

Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Created-By: Apache Maven
Built-By: root
Build-Jdk: 11.0.16
Bundle-ManifestVersion: 1
Bundle-Version: 0.0.1
Bundle-Name: nuxeo api documentation repository
Bundle-SymbolicName: org.nuxeo.apidoc.repo;singleton:=true
Bundle-Vendor: Nuxeo
Nuxeo-Component: OSGI-INF/schema-contrib.xml, OSGI-INF/doctype-contrib
 .xml, OSGI-INF/life-cycle-contrib.xml, OSGI-INF/snapshot-service-fram
 ework.xml, OSGI-INF/adapter-contrib.xml, OSGI-INF/listener-contrib.xml

Exports

Json Export Default Json serialization
Json Graph Json dependency graph
Json Contribution Stats Json statistics for contributions
CSV Contribution Stats CSV statistics for contributions

Charts

Raw Data: Json Contribution Stats

Contributions by Code Type

Loading data

Contributions by Target Extension Point

Loading data

Contributions by Studio Source

Loading data